/*
 * Copyright (c) 2015, 2021 Arm Limited
 * All rights reserved
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "sim/power/thermal_domain.hh"

#include <algorithm>

#include "base/statistics.hh"
#include "debug/ThermalDomain.hh"
#include "params/ThermalDomain.hh"
#include "sim/clocked_object.hh"
#include "sim/linear_solver.hh"
#include "sim/power/thermal_model.hh"
#include "sim/probe/probe.hh"
#include "sim/sub_system.hh"

namespace gem5
{

ThermalDomain::ThermalDomain(const Params &p)
    : SimObject(p), _initTemperature(p.initial_temperature),
    node(NULL), subsystem(NULL),
    ADD_STAT(currentTemp, statistics::units::DegreeCelsius::get(), "Temperature")
{
    currentTemp
        .functor([this]() { return currentTemperature().toCelsius(); });
}

Temperature
ThermalDomain::currentTemperature() const
{
    return node->temp;
}

void
ThermalDomain::setSubSystem(SubSystem * ss)
{
    assert(!this->subsystem);
    this->subsystem = ss;

    ppThermalUpdate = new ProbePointArg<Temperature>(
        subsystem->getProbeManager(), "thermalUpdate");
}

void
ThermalDomain::emitUpdate()
{
    ppThermalUpdate->notify(node->temp);
}


LinearEquation
ThermalDomain::getEquation(ThermalNode * tn, unsigned n, double step) const
{
    LinearEquation eq(n);
    double power = subsystem->getDynamicPower() + subsystem->getStaticPower();
    if (tn == node)
        eq[eq.cnt()] = power;
    return eq;
}

} // namespace gem5
